Skip to content

refactor(Layout): improve context menu instance#5768

Merged
ArgoZhang merged 22 commits intomainfrom
tab_table
Apr 2, 2025
Merged

refactor(Layout): improve context menu instance#5768
ArgoZhang merged 22 commits intomainfrom
tab_table

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Apr 2, 2025 •
edited by sourcery-ai Bot
Loading

Link issues

fixes #5767

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Improve the Tab component's context menu and template rendering by updating method signatures and refactoring the rendering logic

New Features:

  • Add support for passing the current Tab instance to template render fragments

Bug Fixes:

  • Fix potential issues with template rendering by explicitly passing the Tab context

Enhancements:

  • Modify template method signatures to pass the current Tab instance as a context
  • Refactor Tab component's rendering logic to separate context menu and tab item list rendering
  • Update ContextMenuZone to use a more conventional private field naming

@bb-auto bb-auto Bot added the enhancement New feature or request label Apr 2, 2025
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 2, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request refactors the Tab component to improve the context menu zone implementation, adds sample data to the Tabs sample page, renames and modifies the ContextMenu property in the ContextMenuZone component, and updates the ToolbarTemplate parameter in the Layout component.

Updated class diagram for the Tab component

classDiagram
  class Tab {
    RenderFragment RenderTabHeader
    RenderFragment ButtonTemplate
    RenderFragment ToolbarTemplate
    RenderFragment BeforeNavigatorTemplate
    RenderFragment AfterNavigatorTemplate
  }

  Tab : +RenderFragment RenderTabHeader
  Tab : +RenderFragment ButtonTemplate
  Tab : +RenderFragment ToolbarTemplate
  Tab : +RenderFragment BeforeNavigatorTemplate
  Tab : +RenderFragment AfterNavigatorTemplate

  note for Tab "ButtonTemplate, ToolbarTemplate, BeforeNavigatorTemplate, and AfterNavigatorTemplate are now RenderFragment<Tab>"
Loading

Updated class diagram for the ContextMenuZone component

classDiagram
  class ContextMenuZone {
    RenderFragment? ChildContent
    ContextMenu? _contextMenu
    +Task OnContextMenu(MouseEventArgs args, object? contextItem)
    +void RegisterContextMenu(ContextMenu contextMenu)
  }
Loading

File-Level Changes

Change Details Files
Refactors the Tab component to improve the context menu zone implementation.
  • Removes the ContextMenuZone component wrapping the tab content when ShowContextMenu is enabled.
  • Moves the conditional rendering of the context menu to within the RenderTabHeader fragment.
  • Introduces new RenderFragment properties RenderTabItemListContextMenu and RenderTabItemList to handle the conditional rendering of tab items with or without the context menu.
  • Removes the CascadingValue component from the RenderTabHeader fragment.
  • Updates the ButtonTemplate, ToolbarTemplate, BeforeNavigatorTemplate and AfterNavigatorTemplate parameters to be RenderFragment instead of RenderFragment.
 src/BootstrapBlazor/Components/Tab/Tab.razor
src/BootstrapBlazor/Components/Tab/Tab.razor.cs
Adds sample data to the Tabs sample page.
  • Adds a List property to the Tabs sample page.
  • Overrides the OnInitialized method to generate sample data for the Items property.
  • Adds a Table component to the TabItem2 content, displaying a subset of the generated Foo items.
 src/BootstrapBlazor.Server/Components/Samples/Tabs.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Tabs.razor
Renames and modifies the ContextMenu property in the ContextMenuZone component.
  • Renames the ContextMenu property to _contextMenu.
  • Updates the RegisterContextMenu method to assign the contextMenu parameter to the _contextMenu field.
  • Updates the OnContextMenu method to use the _contextMenu field when showing the context menu.
 src/BootstrapBlazor/Components/ContextMenu/ContextMenuZone.razor.cs
Updates the ToolbarTemplate parameter in the Layout component.
  • Updates the ToolbarTemplate parameter to be RenderFragment instead of RenderFragment.
 src/BootstrapBlazor/Components/Layout/Layout.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5767 Improve the context menu zone for the Tab component. ✅
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto Bot added this to the v9.5.0 milestone Apr 2, 2025
sourcery-ai[bot]
sourcery-ai Bot previously approved these changes Apr 2, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider extracting the tab header rendering logic into a separate component for better organization.
  • The cascading values seem to be used to pass the Tab instance, consider using state management or service injection instead.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread src/BootstrapBlazor/Components/Tab/Tab.razor.cs Outdated
ArgoZhang added 2 commits April 2, 2025 14:39
@ArgoZhang
Merge branch 'main' into tab_table
2552cbd
@ArgoZhang
Revert "更新demo"
8453882 
This reverts commit 860640a.

# Conflicts:
#	src/BootstrapBlazor.Server/Components/Samples/Tabs.razor.cs
@ArgoZhang ArgoZhang changed the title feat(Tab): improve context menu zone feat(Layout): improve context menu zone Apr 2, 2025
@ArgoZhang ArgoZhang changed the title feat(Layout): improve context menu zone refactor(Layout): improve context menu instance Apr 2, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 2, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b0c29a6) to head (8453882).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5768   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          658       658           
  Lines        30030     30029    -1     
  Branches      4243      4243           
=========================================
- Hits         30030     30029    -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang merged commit 208d440 into main Apr 2, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the tab_table branch April 2, 2025 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

@ArgoZhang ArgoZhang

Labels

enhancement New feature or request

Projects

None yet

Milestone

v9.5.0

Development

Successfully merging this pull request may close these issues.

refactor(Layout): improve context menu instance

2 participants

@ArgoZhang @kimdiego2098